WirelessPrinter SDK Reference

一、引言

1.1、编写目的

1.2、预期读者

​ 本文档的预期读者为开发本公司打印机关联的应用程序的用户、开发人员、项目经理、测试人员和文档编写人员,用来对项目涉及的业务知识和系统开发所需解决的问题、满足的需求达成共识。

1.2.1、开发人员要求

使用 WirelessPrinter iOS SDK 进行二次开发,您需要了解:

1.3、文中特殊的定义和缩写

1.3.1、定义

characteristic:BLE 蓝牙的特征值

services:BLE 蓝牙的服务

RSSI:BLE 蓝牙的信号强度

Dispatcher:通讯调度员,管理和打印机的 WiFi 和 Bluetooth 4.0 通讯

1.3.2、缩写

BLE:蓝牙4.0、低功耗蓝牙,区别于4.0以前的传统蓝牙

SDK:指 PrinterCommand.framework,PrinterDispatch.framework

1.4、参考资料

二、SDK 更新及变化

变更类型:(A 增加),( M 修订),( D 删除)

2.1、PrinterCommand.framework

Objective-C 语言框架

版本时间变更摘要变更
v1.1.02016.3.8支持 TSC-TSPL 指令集A
v1.1.22016.3.21支持 ESC-POS 指令集M
v1.1.32016.3.25新增支持 PDF 转图片打印。A
v1.2.02016.4.1新增支持两种图片压缩算法,Beta 版的 Office 文档打印A
v1.3.02016.5.25新增支持 ZPL 指令集A

2.2、PrinterDispatch.framework

版本时间变更摘要变更
v1.0.02016.2支持蓝牙A
v1.0.32016.2.29支持 WiFiA
v1.1.12016.3.10PTDispatcher 统一管理蓝牙和 WiFiA

2.2、PrinterCommandSwift.framework

Swift 语言框架

版本时间变更摘要变更
V1.0.02016.4.21新增 CPCL 指令集A

三、开发环境配置

3.1、SDK 版本要求

框架iOS 系统要求
PrinterCommand.framework支持 iOS 6.0及以上
PrinterCommandSwift.framework支持 iOS 8.0 及以上
PrinterDispatch.framework支持 iOS 6.0及以上
PTPrinter Demo支持 iOS 8.0 及以上

3.2 、SDK 引入工程

3.2.1 导入 PrinterCommand.framework、PrinterDispatch.framework

import framework

3.2.2 导入 PrinterCommandSwift.framework

PrinterCommandSwift.framework 使用了 Swift 语言编写,当前支持 CPCL 指令集,需要配合 PrinterCommand.framework 进行连接打印机和处理图片等相关操作。

Objc with Swift

左边使用 Swift 调用,右边使用 Objective-C 调用

3.3、 真机运行和调试

bundle identifier

3.4 、Archive 上架

四、WirelessPrinter Demo 介绍

4.1、 通过指令组合打印

根据不同的指令集不同,大致上提供了一下功能:

通过本 Demo,您可以了解到:

HPRTPrinter CommandView

4.2、 通过模板打印

通过模板打印,电子面单的样式已经预先编辑好,只需要填充相应的数据项,即可打印输出一张面单。这里以申通快递为例,具体代码见 PTTestTSC 类。

1、填充数据

xxxxxxxxxx
20
1
// 使用说明:
2
// 1. 初始化一个 NSMutableDictionary,在相应的键值下塞入对应的的数据,键值必须是下面样例中用到的键值。
3
// 2. 如果一个数据项没有数据 那么也需要设置成空字符串@"",比如 [templateDict setObject:@"" forKey:kCollection];
4
PTLabelTemplate *template = [[PTLabelTemplate alloc] init];
5
NSMutableDictionary *templateDict = [[NSMutableDictionary alloc] init];
6
​
7
[templateDict setObject:@"363604310467" forKey:LTBarcode];
8
[templateDict setObject:@"上海 上海市 长宁区" forKey:LTDistributing];
9
    
10
[templateDict setObject:@"申大通" forKey:LTReceiver];
11
[templateDict setObject:@"13826514987" forKey:LTReceiverContact];
12
[templateDict setObject:@"上海市宝山区共和新路4719弄共和小区12号306室" forKey:LTReceiverAddress];
13
    
14
[templateDict setObject:@"快小宝" forKey:LTSender];
15
[templateDict setObject:@"13826514987\r\n" forKey:LTSenderContact];
16
[templateDict setObject:@"上海市长宁区北瞿路1178号(鑫达商务楼)1号楼305室" forKey:LTSenderAddress];
17
    
18
[templateDict setObject:@"SHENTONG" forKey:LTExpressCompany];
19
    
20
NSData *cmdData = [template getShenTongTemplate:templateDict];

2、读入模板

使用时需要把模板文件拖入你的工程中。模板文件是 TXT 纯文本文件。

 
2
1
 NSString *path = [[NSBundle mainBundle] pathForResource:@"ShenTong" ofType:@"txt"];
2
 NSData *templateData = [template getTemplateDataWithFilePath:path];

3、结合模板和数据

 
xxxxxxxxxx
2
1
NSMutableData *finalData = [[NSMutableData alloc] initWithData:templateData];
2
[finalData appendData:cmdData];

4、发送打印

 
1
1
[[PTDispatcher share] sendData:finalData];

4.3、 获取打印机的纸张状态

1、 当连接蓝牙时,必须订阅状态通知。

xxxxxxxxxx
1
1
[[PTDispatcher share] connectBluetooth:peripheral notify:YES]; // 设置为 YES

2、 具体的获取纸张状态详见 Demo。

PTCommandVC 类中 getPaperStatus:方法

五、PrinterDispatch.framework

5.1、支持的通讯方式

在一些 iOS 机型上,同时打开蓝牙和 WiFi 会导致蓝牙频繁断线,当频繁断线是,请尝试关闭 iOS 系统的WiFi 以保证蓝牙连接的稳定性。

六、PrinterCommand.framework

6.1、支持的打印机指令集

您需要了解所使用的打印机是否支持以下任意一种或多种打印指令集

打印指令集所在框架介绍
ESC-POSPrinterCommand.framework主要应用于票据打印机
TSC-TSPLPrinterCommand.framework主要应用于标签打印机
CPCLPrinterCommandSwift.frameworkZebra 兼容打印机
ZPLPrinterCommand.frameworkZebra 兼容打印机

七、支持的打印机

八、 PrinterCommandSwift.framework

类名功能
PTCommandCPCLCPCL 指令集

本框架当前只有指令部分,没有通讯部分和图片处理部分

当您不需要 CPCL 指令集时,不需要引入此框架

当您需要 CPCL 指令集时,除了需要引入此框架,还需要引入 PTPrinterSDK.Framework

七、API 导航

类名功能
PTCommandESCESC-POS 指令集
PTCommandTSPLTSC-TSPL指令集
PTBitmap图像处理功能,可以生成二值图像和经过抖动的视觉灰度图像。
PTCommandCPCLCPCL指令集
PTCommandZPLZPL 指令集
类名功能
PTDispatcher封装 PTNetwork和 PTBluetooth,蓝牙和 WiFi 两种通讯 API。 提供统一的调用接口,是唯一可以外部调用的通讯接口。